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:Update LangSmith API with new endpoints and modified controller methods #132

Merged
merged 1 commit into from
Nov 19, 2024

Conversation

HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Nov 19, 2024

Summary by CodeRabbit

  • New Features
    • Introduced new endpoints for managing annotation queues, custom charts, service accounts, playground settings, tags, taggings, usage limits, TTL settings, prompts, and workspaces.
    • Enhanced functionality for creating, updating, and deleting various entities within the application.

These updates provide users with more control and flexibility in managing their resources and settings.

Copy link

coderabbitai bot commented Nov 19, 2024

Walkthrough

The changes in this pull request involve significant updates to the LangSmith API as defined in the openapi.yaml file. New endpoints have been added for managing various resources, including annotation queues, custom charts, service accounts, playground settings, tags, taggings, usage limits, TTL settings, prompts, and workspaces. Additionally, several methods have been introduced or modified in their respective controllers to support these new functionalities.

Changes

File Path Change Summary
src/libs/LangSmith/openapi.yaml Added new endpoints for managing annotation queues, custom charts, service accounts, playground settings, tags, taggings, usage limits, TTL settings, prompts, and workspaces.
src/annotation_queues/controller.py Added methods: create_annotation_queue, updated get_annotation_queue.
src/charts/controller.py Added methods: create_chart, update_chart, delete_chart, create_section, update_section, delete_section.
src/service_accounts/controller.py Added methods: create_service_account, delete_service_account.
src/playground_settings/controller.py Added methods: create_playground_settings, update_playground_settings, delete_playground_settings.
src/tags/controller.py Added methods: create_tag_key, update_tag_key, delete_tag_key, create_tag_value, update_tag_value, delete_tag_value.
src/taggings/controller.py Added methods: create_tagging, delete_tagging.
src/usage_limits/controller.py Added methods: list_usage_limits, upsert_usage_limit, delete_usage_limit.
src/ttl_settings/controller.py Added methods: list_ttl_settings, upsert_ttl_settings.
src/prompts/controller.py Added methods: invoke_prompt, prompt_canvas.
src/workspaces/controller.py Added methods: list_workspaces, create_workspace, patch_workspace.

Possibly related PRs

Suggested reviewers

  • github-actions

🐇 In the meadow, hops a bunny bright,
New endpoints added, what a delight!
For charts and queues, and workspaces too,
With tags and prompts, there's much we can do!
So let's celebrate with a joyful cheer,
For LangSmith's growth, we hold so dear! 🐇✨


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 merged commit b93a962 into main Nov 19, 2024
3 checks passed
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Update LangSmith API with new endpoints and modified controller methods Nov 19, 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: 0

🧹 Outside diff range and nitpick comments (1)
src/libs/LangSmith/openapi.yaml (1)

15435-15435: Enhance schema definitions with descriptions and consistent defaults.

The boolean configuration properties could benefit from:

  1. Adding descriptions to explain their purpose and impact
  2. Consistent specification of default values

Consider applying this enhancement:

 kv_dataset_message_support:
   title: Kv Dataset Message Support
   type: boolean
   default: true
+  description: "Controls support for key-value dataset messages in the API"
 show_playground_prompt_canvas:
   title: Show Playground Prompt Canvas
   type: boolean
+  default: false
+  description: "Controls visibility of the prompt canvas feature in the playground interface"
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2e5ecff and 86e1f11.

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

15435-15435: Verify completeness of API specification changes.

The AI summary indicates extensive API changes including new endpoints for annotation queues, charts, service accounts, and more. However, the visible changes only show configuration properties. Let's verify the completeness of the changes.

✅ Verification successful

API specification changes are present and extensive

The search results confirm the presence of numerous new API endpoints mentioned in the summary:

  • New annotation queue endpoints under /api/v1/annotation-queues/
  • Chart-related endpoints under /api/v1/charts/
  • Service account endpoints under /api/v1/service-accounts/
  • Playground settings under /api/v1/playground-settings/
  • Tag and tagging operations under various paths
  • Usage limits endpoints under /api/v1/usage-limits/
  • TTL settings endpoints under /api/v1/ttl-settings/
  • Prompt-related endpoints under /api/v1/prompts/
  • Workspace management under /api/v1/workspaces/

Additionally, there are several deprecated endpoints being replaced by their workspace counterparts, indicating a significant API restructuring.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the presence of new API endpoints mentioned in the summary

# Search for new endpoint paths in the OpenAPI spec
echo "Searching for new endpoints..."
rg -A 2 "/annotation-queues|/charts|/service-accounts|/playground-settings|/tags|/taggings|/usage-limits|/ttl-settings|/prompts|/workspaces" src/libs/LangSmith/openapi.yaml

# Count total paths to understand the scale of changes
echo "Counting total paths..."
yq '.paths | keys | length' src/libs/LangSmith/openapi.yaml

Length of output: 6318

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