Skip to content

feat:Update embedding_types descriptions for model version compatibility in OpenAPI #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
May 1, 2025
Merged

feat:Update embedding_types descriptions for model version compatibility in OpenAPI #184

merged 1 commit into from
May 1, 2025

Conversation

HavenDV
Copy link
Contributor

@HavenDV HavenDV commented May 1, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation
    • Clarified descriptions of embedding type compatibility in the API documentation to better specify which model versions support each type. No changes to functionality or API behavior.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented May 1, 2025 •
edited
Loading

Walkthrough

The changes revise the descriptive text for the embedding_types property in several locations within the Cohere API's OpenAPI specification. The updates clarify which model versions support each embedding type by replacing ambiguous phrases with more precise wording, specifying compatibility with "Embed v3.0 and newer Embed models" or "v3 and newer model versions." No functional code, logic, or exported entities are altered; only documentation within the OpenAPI YAML file is updated.

Changes

File(s) Change Summary
src/libs/Cohere/openapi.yaml Updated descriptions for embedding_types in multiple endpoints and schemas for clarity on model compatibility.

Possibly related PRs

Poem

In the garden of docs, a change so neat,
Clarified words for models to meet.
No code was touched, just guidance anew,
For embedding types, now clearer for you.
🐇✨

Hop, hop, hooray—
Documentation’s brighter today!

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

@HavenDV HavenDV enabled auto-merge May 1, 2025 18:30
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Update embedding_types descriptions for model version compatibility in OpenAPI May 1, 2025
coderabbitai[bot]
coderabbitai bot reviewed May 1, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/libs/Cohere/openapi.yaml (2)

2155-2155: Consider unifying compatibility phrasing across docs

The description here uses “Supported with all Embed models” / “Supported with Embed v3.0 and newer Embed models,” but other endpoints opt for “Valid for…”. For a cohesive developer experience, standardize on a single phrasing across all embedding_types descriptions.

12613-12613: Standardize embedding compatibility phrasing

This /v2/embed description uses “Valid for all models” and “Valid for v3 and newer model versions.” To keep the spec uniform, align this wording with the phrasing used in other endpoints (e.g., “Supported with all Embed models” / “Supported with Embed v3.0 and newer Embed 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 15ceb75 and ca1ad2a.

⛔ Files ignored due to path filters (9)
  • 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.EmbedJobsClient.CreateEmbedJob.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.IEmbedJobsClient.CreateEmbedJob.g.cs is excluded by !**/generated/**
  • src/libs/Cohere/Generated/Cohere.Models.CreateEmbedJobRequest.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)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test / Build, test and publish
🔇 Additional comments (1)
src/libs/Cohere/openapi.yaml (1)

7987-7987: Verify default behavior documentation

In the /v1/embed-jobs property description, the “Not required and default is None, which returns the Embed Floats response type” clause is omitted, unlike in the other embed endpoints. If the default behavior is the same, re-add that note to maintain consistency.

@HavenDV HavenDV merged commit 2a81982 into main May 1, 2025
4 checks passed
@HavenDV HavenDV deleted the bot/update-openapi_202505011829 branch May 1, 2025 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@github-actions github-actions[bot] github-actions[bot] approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@HavenDV