feat:Clarify image embedding support for Embed v3.0+ in OpenAPI descriptions

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Clarified in the API documentation that image embeddings are supported only with Embed version 3.0 and newer models.

[coderabbitai]

Walkthrough

The OpenAPI specification for the Cohere API was updated to clarify in the descriptions that image embeddings are supported only with Embed version 3.0 and newer models. No structural or schema changes were made; only descriptive text was modified to note this model version requirement.

Changes

File(s)	Change Summary
src/libs/Cohere/openapi.yaml	Updated descriptions for image embedding fields to specify support only with Embed v3.0 and newer models.

Possibly related PRs

• feat:Update OpenAPI specifications in src/libs/Cohere/openapi.yaml file #83: Also modifies the OpenAPI specification file, likely related to updating or clarifying API documentation.

Poem

🐇
In the garden of docs where the schemas grow,
A note was added so all will know:
Image embeddings, shiny and new,
Need Embed v3.0 to come into view.
With clarity sown, the API's neat—
Now hop ahead, your models complete!

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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

🧹 Nitpick comments (2)

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

8000-8000: Unify phrasing across embed versions.
The description in /v2/embed currently reads "Image embeddings are supported with Embed v3.0 and newer models." Consider mirroring the /v1/embed phrasing by adding "only" for consistency and emphasis.

-                  description: "An array of image data URIs for the model to embed. Maximum number of images per call is `1`.\n\nThe image must be a valid [data URI](https://developer.mozilla.org/en-US/docs/Web/URI/Schemes/data). The image must be in either `image/jpeg` or `image/png` format and has a maximum size of 5MB.\n\nImage embeddings are supported with Embed v3.0 and newer models."
+                  description: "An array of image data URIs for the model to embed. Maximum number of images per call is `1`.\n\nThe image must be a valid [data URI](https://developer.mozilla.org/en-US/docs/Web/URI/Schemes/data). The image must be in either `image/jpeg` or `image/png` format and has a maximum size of 5MB.\n\nImage embeddings are only supported with Embed v3.0 and newer models."

---

15267-15267: Clarify model support in schema description.
The new description concisely notes version support. Optionally, you could add "only" before "Supported" for parallelism with other descriptions, but this is a minor stylistic choice.

-      description: Image content of the input. Supported with Embed v3.0 and newer models.
+      description: Image content of the input. Only supported with Embed v3.0 and newer models.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8cc3b5c and a13e405.

⛔ Files ignored due to path filters (8)

• src/libs/Cohere/Generated/Cohere.CohereClient.Embed.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.CohereClient.Embedv2.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.ICohereClient.Embed.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.ICohereClient.Embedv2.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.Models.EmbedContent.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.Models.EmbedImage.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.Models.EmbedRequest.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.Models.Embedv2Request.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🔇 Additional comments (1)

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

2168-2168: Description adds model version requirement for images.
The updated description clearly indicates that image embeddings require Embed v3.0 or newer, improving consumer understanding.