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

[HavenDV]

Summary by CodeRabbit

• New Features
  • Introduced a new API endpoint for batch ingest runs at /api/v1/runs/multipart to enhance multipart processing capabilities.
  • Added a configuration option use_multipart_endpoint in the BatchIngestConfig, defaulting to true, allowing users to control the use of the new endpoint.

[coderabbitai]

Walkthrough

The changes introduce a new POST endpoint at /api/v1/runs/multipart in the OpenAPI specification for handling multipart runs, identified by the operation ID multipart_ingest_runs_api_v1_runs_multipart_post. This endpoint is categorized under "run" and requires specific security credentials. Additionally, a new boolean property, use_multipart_endpoint, is added to the BatchIngestConfig component, defaulting to true. These modifications enhance the API's functionality and update the configuration schema.

Changes

Files	Change Summary
src/libs/LangSmith/openapi.yaml	Added new endpoint POST /api/v1/runs/multipart with operation ID multipart_ingest_runs_api_v1_runs_multipart_post. Added property use_multipart_endpoint of type boolean with default value true in BatchIngestConfig.

Poem

In the meadow, hops a rabbit bright,
New paths to run, oh what a delight!
Multipart journeys, we now can take,
With configurations that we can make.
Hooray for the changes, let’s dance and play,
In the world of APIs, we leap all day! 🐇✨

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

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

4074-4090: New endpoint added for multipart ingest runs

A new endpoint has been added to handle multipart ingest of runs. This is a good addition as it allows for more efficient batch processing of run data. Here are some observations and suggestions:

1. The endpoint is correctly tagged under "run" and has a clear description.
2. The operation ID multipart_ingest_runs_api_v1_runs_multipart_post is descriptive and follows the naming convention of other endpoints.
3. The security requirements (ApiKey, TenantId, BearerAuth) are consistent with other endpoints.
4. The response is set to return a JSON object, but the schema is currently unspecified. It would be beneficial to define the response schema for better documentation and client-side type checking.

Consider adding a response schema to provide more information about the expected response format. For example:

responses:
  '200':
    description: Successful Response
    content:
      application/json:
        schema:
          $ref: '#/components/schemas/MultipartIngestRunsResponse'

Then, define the MultipartIngestRunsResponse schema in the components section of the OpenAPI specification.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f5f8087 and ba27eb6.

⛔ Files ignored due to path filters (5)

• src/libs/LangSmith/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IRunClient.MultipartIngestRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.BatchIngestConfig.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.MultipartIngestRunsApiV1RunsMultipartPostResponse.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.RunClient.MultipartIngestRuns.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🔇 Additional comments (2)

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

10181-10184: New property added to BatchIngestConfig

A new property use_multipart_endpoint has been added to the BatchIngestConfig component. This addition is consistent with the new multipart ingest runs endpoint. Here are some observations:

1. The property is of type boolean with a default value of true.
2. This allows users to control whether the multipart endpoint should be used for batch ingestion.
3. The property is well-placed within the BatchIngestConfig component.

This change provides flexibility for clients to choose between the new multipart endpoint and the existing batch ingest method. It's a good practice to allow for backward compatibility while introducing new features.

---

Line range hint 1-10184: Summary of changes

The changes to the OpenAPI specification introduce a new feature for multipart ingest of runs while maintaining backward compatibility. Here's an overview of the improvements:

1. A new endpoint /api/v1/runs/multipart has been added for multipart ingest of runs.
2. The BatchIngestConfig component has been updated with a use_multipart_endpoint property to control the use of this new endpoint.

These changes enhance the API's capabilities for handling batch data ingestion more efficiently. The implementation is well-structured and follows the existing patterns in the API specification.

The additions are valuable and have been implemented without breaking existing functionality. To further improve the documentation:

1. Consider adding a more detailed description of the multipart ingest process in the endpoint's description.
2. Develop and include a response schema for the new endpoint to provide clear expectations for API consumers.
3. Update any relevant documentation or client libraries to reflect these new capabilities.

Overall, these changes represent a positive evolution of the LangSmith API.