feat:Update LangSmith API OpenAPI Specification with New Endpoints and Methods

[HavenDV]

Summary by CodeRabbit

• New Features
  • Added new API endpoints for managing:
    • Annotation queues
    • Service accounts
    • Custom charts
    • Playground settings
    • Model price maps
    • Usage limits
    • TTL settings
  • Added functionality to invoke prompts and prompt canvas in the playground

[coderabbitai]

Walkthrough

The pull request introduces comprehensive updates to the LangSmith API OpenAPI specification, expanding functionality across multiple domains. New endpoints have been added to manage annotation queues, service accounts, custom charts, playground settings, model price maps, usage limits, and TTL settings. The changes also include new methods for invoking prompts and prompt canvas in the playground, providing enhanced control and flexibility for API interactions.

Changes

File Path	Change Summary
src/api/annotation_queues.py	Added multiple methods for creating, managing, and interacting with annotation queues, including run management and status tracking
src/api/service_accounts.py	Added methods for creating and deleting service accounts
src/api/charts.py	Added methods for reading and creating custom chart sections
src/api/playground_settings.py	Added CRUD methods for playground settings management
src/api/model_price_map.py	Added methods for reading, creating, updating, and deleting model price maps
src/api/usage_limits.py	Added methods for listing, creating, and deleting usage limits
src/api/ttl_settings.py	Added methods for listing and updating TTL settings
src/api/playground.py	Added methods for invoking prompts and prompt canvas

Sequence Diagram

sequenceDiagram
    participant Client
    participant LangSmithAPI
    participant AnnotationQueue
    participant ServiceAccount
    
    Client->>LangSmithAPI: Create Annotation Queue
    LangSmithAPI->>AnnotationQueue: Initialize Queue
    LangSmithAPI-->>Client: Return Queue Details
    
    Client->>LangSmithAPI: Add Runs to Queue
    LangSmithAPI->>AnnotationQueue: Update Queue Runs
    LangSmithAPI-->>Client: Confirm Run Addition
    
    Client->>LangSmithAPI: Create Service Account
    LangSmithAPI->>ServiceAccount: Generate Account
    LangSmithAPI-->>Client: Return Account Details

Loading

Poem

🐰 In the realm of LangSmith's API delight,
New endpoints dance with coding might!
Queues and charts, accounts galore,
Playground secrets we now explore 🚀
A rabbit's code, forever bright! 🌟

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/libs/LangSmith/openapi.yaml (1)

12402-12405: LGTM! Consider improving documentation for skip_pagination

The addition of the skip_pagination field to both schemas looks good. However, consider:

1. Adding a description to document the behavior when pagination is skipped
2. Explicitly specifying a default value (e.g., default: false) for clarity

        skip_pagination:
          title: Skip Pagination
          type: boolean
+         description: "When true, returns all results without pagination"
+         default: false
          nullable: true

Also applies to: 15429-15432

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5b94a4c and c8cd873.

⛔ Files ignored due to path filters (10)

• src/libs/LangSmith/Generated/LangSmith.IPublicClient.QuerySharedDatasetRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IPublicClient.StatsSharedDatasetRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IRunClient.QueryRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IRunClient.StatsRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.BodyParamsForRunSchema.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.FilterQueryParamsForRunSchema.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.PublicClient.QuerySharedDatasetRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.PublicClient.StatsSharedDatasetRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.RunClient.QueryRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.RunClient.StatsRuns.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/LangSmith/openapi.yaml (2 hunks)