feat:Update openapi.yaml with structured message methods and new examples

[HavenDV]

Summary by CodeRabbit

• New Features

  • Enhanced message handling in Java and Python SDKs for clearer chat message roles.
  • Added new TypeScript and cURL examples for embed and rerank endpoints.

• Improvements

  • Improved overall structure and readability of code examples in the SDK documentation.

[coderabbitai]

Walkthrough

The pull request introduces updates to the openapi.yaml file, primarily affecting the Java and Python SDKs. Key changes include the adoption of structured message creation methods in both SDKs, modifications to the tools section to utilize cohere.ToolV2, and the addition of new TypeScript and cURL examples for the embed and rerank endpoints. Overall, these updates enhance the clarity and consistency of message handling across different programming languages.

Changes

File Path	Change Summary
src/libs/Cohere/openapi.yaml	Updated Java SDK's Default and Streaming classes for structured message handling. Modified Python SDK's chat and chat_stream methods similarly. Tools sections in both SDKs updated to cohere.ToolV2. Added TypeScript and cURL examples for embed and rerank endpoints. Enhanced overall structure and readability of examples.

Poem

In the meadow, changes bloom,
With tools that now have room to zoom.
Messages clear, like morning light,
Java and Python, a joyful sight.
With TypeScript and cURL, we play,
Hopping forward, hip-hip-hooray! 🐇✨

---

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/Cohere/openapi.yaml (1)

3866-4865: Consider truncating the response example for brevity.

While providing a detailed response example is valuable, the current array of floating-point numbers is quite extensive. Consider truncating this array to show only the first few and last few elements, using an ellipsis to indicate omitted values. This would maintain the illustrative purpose while improving readability and reducing the overall file size.

For example:

embeddings:
  - [0.016296387, -0.008354187, -0.04699707, ..., 0.015838623, -0.008674622, 0.0002270937]

Tools

yamllint

[error] 4835-4835: trailing spaces

(trailing-spaces)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 583931a and 1dc536c.

Files selected for processing (1)

• src/libs/Cohere/openapi.yaml (5 hunks)

Additional context used

yamllint

src/libs/Cohere/openapi.yaml

[error] 3810-3810: trailing spaces

(trailing-spaces)

---

[error] 4835-4835: trailing spaces

(trailing-spaces)

Additional comments not posted (4)

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

3778-3865: Great addition of comprehensive code samples for the embed endpoint!

The inclusion of examples for TypeScript, Python (both sync and async), Java, and cURL provides excellent guidance for developers across different programming languages. The code samples are well-structured and clearly demonstrate how to use the embed endpoint. This addition will significantly improve the developer experience and ease of integration.

Tools

yamllint

[error] 3810-3810: trailing spaces

(trailing-spaces)

---

4866-5865: Metadata inclusion enhances the response example.

The addition of metadata, including the API version and billed units, provides valuable information for developers. This helps in understanding the billing model and keeping track of the API version being used.

---

6508-6525: Excellent addition of code samples for the rerank endpoint.

The inclusion of examples for TypeScript, Python (both sync and async), Java, and cURL maintains consistency with the embed endpoint examples. These well-structured code samples provide clear guidance on how to use the rerank endpoint across different programming languages, which will greatly benefit developers integrating this functionality.

---

6526-6550: Clear and informative request and response examples for the rerank endpoint.

The request example effectively demonstrates the expected input format, including multiple documents, the query, and other necessary parameters. The response example provides a clear illustration of the output, with relevance scores for the ranked documents. The inclusion of metadata in the response maintains consistency with the embed endpoint example. These examples will be very helpful for developers in understanding how to use and interpret the results of the rerank endpoint.