Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat:Add API endpoints for managing tracer sessions, organizations, and queues #142

Merged
merged 1 commit into from
Nov 28, 2024

Conversation

HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Nov 28, 2024

Summary by CodeRabbit

  • New Features
    • Introduced new API endpoints for managing tracer sessions, organizations, and annotation queues.
    • Users can now create, update, and delete tracer sessions and organizations.
    • Enhanced management of annotation queues with options to add, update, and remove runs.

Copy link

coderabbitai bot commented Nov 28, 2024

Walkthrough

The changes in this pull request introduce new API endpoints for managing tracer sessions, organizations, and annotation queues within the LangSmith platform. Key updates include the addition of methods for creating, updating, and deleting tracer sessions and organizations, as well as managing annotation queues and their associated runs. The modifications enhance the overall functionality and management capabilities of these components.

Changes

File Path Change Summary
src/libs/LangSmith/openapi.yaml - Added methods for creating, updating, and deleting tracer sessions.
- Added methods for managing organizations, including roles and members.
- Added methods for creating, updating, and deleting annotation queues, along with managing runs in those queues.

Possibly related PRs

Suggested reviewers

  • github-actions

🐇 In the meadow, we hop and play,
New endpoints here, hip-hip-hooray!
For sessions and queues, we manage with glee,
Organizations too, as happy as can be!
With each new method, we grow and thrive,
In the LangSmith world, our code comes alive! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot enabled auto-merge November 28, 2024 03:34
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Add API endpoints for managing tracer sessions, organizations, and queues Nov 28, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6c1fe1d and 905c9a5.

⛔ Files ignored due to path filters (6)
  • src/libs/LangSmith/Generated/LangSmith.DatasetsClient.DatasetHandler.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.DatasetsClient.StreamDatasetHandler.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.IDatasetsClient.DatasetHandler.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.IDatasetsClient.StreamDatasetHandler.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.OrganizationConfig.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundRunOverDatasetRequestSchema.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/LangSmith/openapi.yaml (2 hunks)
🔇 Additional comments (1)
src/libs/LangSmith/openapi.yaml (1)

16013-16016: Verify the feature flag implementation

The new feature flag enable_custom_experiment_names is well-defined. However, we should ensure proper implementation across the codebase.

✅ Verification successful

Feature flag implementation is properly integrated

The feature flag enable_custom_experiment_names is correctly implemented:

  • It's properly defined in the OpenAPI specification with appropriate default value
  • The C# model has been correctly generated with the feature flag as a nullable boolean property
  • The flag is positioned logically in the schema alongside other feature flags
  • It's related to the experiment_name field in the ExperimentResultsUpload schema, which suggests proper integration with the experiment naming functionality
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for references to the new feature flag to ensure proper implementation

# Search for any references to the feature flag in the codebase
rg -l "enable_custom_experiment_names"

# Check for any conditional logic related to experiment names
ast-grep --pattern 'experiment_name' 

Length of output: 304


Script:

#!/bin/bash
# Let's examine the context around the experiment_name references and the generated C# model

# Check the context around experiment_name in the OpenAPI spec
rg -A 5 -B 5 "experiment_name" src/libs/LangSmith/openapi.yaml

# Check the generated C# model for the feature flag implementation
cat src/libs/LangSmith/Generated/LangSmith.Models.OrganizationConfig.g.cs

Length of output: 11247

@@ -16447,6 +16451,7 @@ components:
- manifest
- secrets
- options
- project_name
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Document the new required fields

The addition of project_name and dataset_id as required fields may impact existing API clients. Please ensure these fields are properly documented with:

  • Field descriptions
  • Format requirements
  • Example values
        - manifest
        - secrets
        - options
        - project_name
        - dataset_id
      type: object
      properties:
+        project_name:
+          type: string
+          description: "The unique identifier of the project"
+          example: "my-project-123"
+        dataset_id:
+          type: string
+          description: "The unique identifier of the associated dataset"
+          example: "dataset-456"

Committable suggestion skipped: line range outside the PR's diff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant