feat:Clarify image embedding support for Embed v3.0+ in OpenAPI descriptions #188
Conversation
WalkthroughThe 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
Possibly related PRs
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/libs/Cohere/openapi.yaml (2)
8000-8000: Unify phrasing across embed versions.
The description in/v2/embedcurrently reads "Image embeddings are supported with Embed v3.0 and newer models." Consider mirroring the/v1/embedphrasing 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
⛔ Files ignored due to path filters (8)
src/libs/Cohere/Generated/Cohere.CohereClient.Embed.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.CohereClient.Embedv2.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ICohereClient.Embed.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.ICohereClient.Embedv2.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.Models.EmbedContent.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.Models.EmbedImage.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.Models.EmbedRequest.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.Models.Embedv2Request.g.csis 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.
Summary by CodeRabbit