feat:Add tracer session metadata and filter view endpoints to OpenAPI spec

[HavenDV]

Summary by CodeRabbit

• New Features
  • Introduced a metadata endpoint offering top values for session metadata keys.
  • Added endpoints to list, create, retrieve, update, and delete filter views for sessions.
  • Enhanced existing session endpoints with new query parameters and additional response details.

[coderabbitai]

Walkthrough

This pull request introduces new API endpoints in the LangSmith OpenAPI specification for tracer sessions. It adds endpoints to retrieve metadata and to manage filter views (read, create, update, and delete). Additionally, minor modifications were made to existing endpoints by adding new query parameters and response fields. All changes are defined within the API schema file.

Changes

File

Change Summary

src/libs/.../openapi.yaml

- Added endpoint /api/v1/sessions/{session_id}/metadata with method read_tracer_sessions_runs_metadata to fetch top K metadata values. - Added endpoints /api/v1/sessions/{session_id}/views for reading (read_filter_views) and creating (create_filter_view) filter views. - Added endpoints /api/v1/sessions/{session_id}/views/{view_id} for read, update (update_filter_view), and delete (delete_filter_view) operations. - Minor updates to existing tracer session endpoints.

Sequence Diagram(s)

sequenceDiagram
  participant Client
  participant API
  participant Database
  Client->>API: GET /api/v1/sessions/{session_id}/metadata?k=10
  API->>Database: Query top K metadata values
  Database-->>API: Return metadata values
  API-->>Client: Metadata response

Loading

sequenceDiagram
  participant Client
  participant API
  participant Database
  Client->>API: GET /api/v1/sessions/{session_id}/views
  API->>Database: Fetch filter views
  Database-->>API: List of filter views
  API-->>Client: Return filter views
  
  Client->>API: POST /api/v1/sessions/{session_id}/views (new view data)
  API->>Database: Create new filter view
  Database-->>API: Confirmation of creation
  API-->>Client: New filter view response

Loading

Possibly related PRs

• feat:Add CRUD endpoints for tracer sessions and filter views in LangSmith API #168: Modifies similar endpoints and methods within the same file related to tracer sessions and filter views.
• feat:Update LangSmith tracer session API endpoints in OpenAPI specification #175: Introduces new endpoints for tracer session metadata, aligning with the changes in this PR.
• feat:Update OpenAPI specification for LangSmith with new endpoints and features #170: Involves similar additions for managing filter views and tracer session metadata, providing a direct code-level connection.

Suggested reviewers

• github-actions

Poem

I'm a coding rabbit, hopping with glee,
New endpoints blooming like flowers in a spree.
Metadata and views now dance in the light,
CRUDs and queries run smooth and bright.
With each line of code, my ears perk high—
A little nibble of joy with every try!
🥕 Happy hops in our API sky!

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d4ffdcb and 1261841.

⛔ Files ignored due to path filters (8)

• src/libs/LangSmith/Generated/LangSmith.IPublicClient.QuerySharedDatasetRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IRunClient.QueryRuns.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.RunSchema.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.RunSchemaWithAnnotationQueueInfo.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.RunSelect.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.PublicClient.QuerySharedDatasetRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.RunClient.QueryRuns.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🔇 Additional comments (4)

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

12586-12592: Verify Addition of thread_id in Query Parameters List

The diff introduces a new list item (- thread_id) within the query parameters section of the run endpoints. Please ensure that this parameter is supported by the backend logic and that its intended purpose is clearly documented in the API reference.

---

19472-19481: Confirm thread_id Schema Inclusion in Run Schema

A new property thread_id (with title "Thread Id", type string, and nullable true) is added within the Run schema. Verify that this aligns with the overall design of the endpoint responses and that clients consuming this API can handle the new property.

---

19854-19863: Ensure Consistency for thread_id in Related Schema

In this schema section, thread_id is again added with similar settings (title "Thread Id", type string, and nullable true). Note that unlike the preceding property (which specifies a UUID format), the new thread_id property does not. Confirm whether thread_id should be formatted as a UUID or kept as a plain string for consistency.

---

19933-19939: Validate thread_id in Run Columns Enumeration

The new - thread_id entry is added to the list of available run columns. Ensure that including this field does not conflict with existing client expectations and that it complements the API’s filtering and ordering capabilities.

---

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.