Skip to content

feat:Add new endpoints for resource management in LangSmith API#109

Merged
github-actions[bot] merged 1 commit intomainfrom
bot/update-openapi_202410250126
Oct 25, 2024
Merged

feat:Add new endpoints for resource management in LangSmith API#109
github-actions[bot] merged 1 commit intomainfrom
bot/update-openapi_202410250126

Conversation

@HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Oct 25, 2024

Summary by CodeRabbit

  • New Features
    • Introduced new endpoints for managing annotation queues, custom charts, playground settings, service accounts, tags, usage limits, TTL settings, prompts, and workspaces.
    • Enhanced capabilities for creating, updating, and deleting various resources, including annotation queues and service accounts.

These updates provide users with more control and flexibility over their data and settings within the application.

@coderabbitai
Copy link

coderabbitai bot commented Oct 25, 2024

Walkthrough

The pull request introduces significant updates to the LangSmith API by adding numerous new endpoints for managing various resources. These include annotation queues, custom charts, playground settings, service accounts, tags, usage limits, TTL settings, prompts, and workspaces. Each resource management feature includes methods for creating, updating, deleting, and retrieving data, thereby expanding the API's functionality and control over these elements.

Changes

File Path Change Summary
src/libs/LangSmith/openapi.yaml Added new endpoints for managing annotation queues, custom charts, playground settings, service accounts, tags, usage limits, TTL settings, prompts, and workspaces.
src/libs/LangSmith/api/annotation_queues.py Added methods for creating, updating, deleting annotation queues, and managing runs within them.
src/libs/LangSmith/api/bulk_exports.py Added methods for bulk export management, including creation, retrieval, and cancellation.
src/libs/LangSmith/api/workspaces.py Added methods for workspace management, including listing, creating, updating, and managing members.
src/libs/LangSmith/api/playground_settings.py Added methods for creating, updating, deleting, and listing playground settings.
src/libs/LangSmith/api/service_accounts.py Added methods for managing service accounts, including creation and deletion.
src/libs/LangSmith/api/charts.py Added methods for managing custom chart sections.

Possibly related PRs

Suggested reviewers

  • github-actions

Poem

🐇 In the meadow where changes bloom,
New endpoints sprout, dispelling gloom.
With queues and charts, we dance and play,
Managing data in a joyful way.
A hop, a skip, let’s celebrate,
For LangSmith's API is truly great! 🌼


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 October 25, 2024 01:27
@github-actions github-actions bot merged commit fda1715 into main Oct 25, 2024
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Add new endpoints for resource management in LangSmith API Oct 25, 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)

15175-15180: Enhance the dataset_splits property documentation and validation.

The dataset_splits property would benefit from additional OpenAPI schema attributes to improve documentation and validation:

 dataset_splits:
   title: Dataset Splits
   type: array
   items:
     type: string
+    description: "The name of a dataset split (e.g., 'train', 'test', 'validation')"
+    enum: ["train", "test", "validation"]
   nullable: true
+  description: "List of dataset splits to process. Common values include 'train', 'test', and 'validation'."
+  example: ["train", "test"]
+  minItems: 1

This enhancement:

  • Adds descriptions to improve API documentation
  • Provides examples to guide API consumers
  • Suggests common split names through an enum
  • Ensures at least one split is specified when the array is not null
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c46733f and 7932926.

⛔ Files ignored due to path filters (8)
  • 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.ILangSmithApi.Health.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.LangSmithApi.Health.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.HealthApiV1HealthGetResponse.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 (1 hunks)

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