feat:Title: Update documentation for API endpoints and usage examples

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced a new property, tool_choice, in multiple components for enhanced flexibility.

• Improvements

  • Streamlined schema definitions by replacing complex references with direct schema links for various parameters, improving clarity and consistency.

[coderabbitai]

Walkthrough

The changes involve updates to the OpenAPI specification, focusing on simplifying schema definitions. This includes the removal of title and allOf properties from various query parameter schemas, replaced with direct schema references using $ref. The modifications apply to parameters such as sort_by and order, as well as properties in the components section like data_type, access_scope, and stride. Additionally, a new property tool_choice has been introduced, allowing for a string or null type.

Changes

File	Change Summary
src/libs/LangSmith/openapi.yaml	- Updated schema references for sort_by, order, data_type, access_scope, and stride to use $ref instead of allOf and default values. - Added new property tool_choice allowing for a string or null type.

Poem

In the land of code where schemas play,
A rabbit hops with joy today.
With $ref so clear, the paths align,
Simplified structures, oh how they shine!
New choices abound, let’s celebrate,
In the realm of APIs, it’s truly great! 🐇✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 352173e and 5b9df16.

Files ignored due to path filters (64)

• src/libs/LangSmith/Generated/AllOf.1.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/JsonConverters.AllOf1.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/JsonConverters.AllOfFactory1.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/JsonSerializerContext.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.ApiKeyClient.GenerateApiKey.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.ApiKeyClient.GeneratePersonalAccessToken.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.ChartsClient.ReadCharts.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.ChartsClient.ReadSingleChart.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.ChartsClient.ReadSingleSection.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.DatasetsClient.CreateDataset.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.DatasetsClient.ReadComparativeExperiments.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.DatasetsClient.ReadDatasets.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.DatasetsClient.UploadCsvDataset.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.ExamplesClient.ReadExamples.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IApiKeyClient.GenerateApiKey.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IApiKeyClient.GeneratePersonalAccessToken.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IChartsClient.ReadCharts.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IChartsClient.ReadSingleChart.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IChartsClient.ReadSingleSection.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IDatasetsClient.CreateDataset.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IDatasetsClient.ReadComparativeExperiments.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IDatasetsClient.ReadDatasets.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IDatasetsClient.UploadCsvDataset.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IExamplesClient.ReadExamples.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IPlaygroundClient.BatchHandler.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IPlaygroundClient.DatasetHandler.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IPlaygroundClient.InvokeHandler.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IPlaygroundClient.StreamDatasetHandler.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IPlaygroundClient.StreamHandler.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IPublicClient.QuerySharedDatasetRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IPublicClient.ReadSharedComparativeExperiments.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IPublicClient.ReadSharedDataset.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IPublicClient.ReadSharedDatasetTracerSessions.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IRunClient.MonitorTracerSession.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IRunClient.QueryRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.ITracerSessionsClient.ReadTracerSessions.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.BodyUploadCsvDatasetApiV1DatasetsUploadPost.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.CustomChartsRequest.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.CustomChartsRequestBase.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.DatasetCreate.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.Identity.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.MemberIdentity.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.MonitorRequest.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.OrgMemberIdentity.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.OrgPendingIdentity.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.PendingIdentity.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundBatchRequestSchema.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundInvokeRequestSchema.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundRunOverDatasetRequestSchema.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.PlaygroundStreamRequestSchema.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.PlaygroundClient.BatchHandler.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.PlaygroundClient.DatasetHandler.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.PlaygroundClient.InvokeHandler.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.PlaygroundClient.StreamDatasetHandler.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.PlaygroundClient.StreamHandler.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.ReadSharedComparativeExperiments.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.PublicClient.ReadSharedDataset.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.PublicClient.ReadSharedDatasetTracerSessions.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.RunClient.MonitorTracerSession.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.RunClient.QueryRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.TracerSessionsClient.ReadTracerSessions.g.cs is excluded by !**/generated/**

Files selected for processing (1)

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

Additional comments not posted (6)

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

179-180: Simplified schema reference for sort_by parameter

The sort_by parameter schema has been simplified by removing the title and allOf properties and directly referencing #/components/schemas/SessionSortableColumns. This change improves consistency and readability of the OpenAPI specification.

---

1992-1993: Consistent schema simplification for order parameter

The order parameter schema has been simplified in the same manner as the sort_by parameter, by removing the title and allOf properties and directly referencing #/components/schemas/ExampleListOrder. This change maintains consistency across the API specification and improves its overall readability.

---

2384-2385: Consistent schema simplification for sort_by parameter in datasets endpoint

The sort_by parameter schema for the datasets endpoint has been simplified in the same manner as previous changes, by removing the title and allOf properties and directly referencing #/components/schemas/SortByDatasetColumn. This change maintains a consistent approach throughout the API specification, improving its overall clarity and maintainability.

---

11589-11590: Consistent schema simplification for data_type property

The data_type property schema in the components section has been simplified following the same pattern as previous changes. The title and allOf properties have been removed, and a direct reference to #/components/schemas/DataType has been added. This change maintains the consistent approach to schema simplification throughout the API specification, enhancing its overall clarity and ease of use.

---

13213-13214: Consistent schema simplification for access_scope property

The access_scope property schema in the components section has been simplified following the same pattern as previous changes. The title and allOf properties have been removed, and a direct reference to #/components/schemas/AccessScope has been added. This change maintains the consistent approach to schema simplification throughout the API specification, further enhancing its overall clarity and consistency.

Also applies to: 13509-13510, 13899-13900, 13967-13968, 14442-14443

---

11277-11278: Consistent schema simplification for stride property

The stride property schema in the components section has been simplified following the same pattern as previous changes. The title and allOf properties have been removed, and a direct reference to #/components/schemas/TimedeltaInput has been added. This change maintains the consistent approach to schema simplification throughout the API specification, further improving its overall clarity and ease of use.

Also applies to: 11312-11313

---

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 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.