Skip to content

feat:Update model id to command-a-03-2025, deprecate safety instr param #169

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.

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

Merged
merged 1 commit into from
Apr 2, 2025

Conversation

HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Apr 2, 2025

Summary by CodeRabbit

  • Documentation
    • Updated API documentation to reference the latest model identifier.
    • Improved parameter descriptions for clearer model compatibility.
    • Marked an outdated parameter as deprecated to guide users toward updated practices.

Copy link

coderabbitai bot commented Apr 2, 2025

Walkthrough

The changes in this pull request update the model identifier in the openapi.yaml file from command-r-plus-08-2024 to command-a-03-2025. Example snippets across multiple SDKs (Python, Java, TypeScript, Go, cURL) have been updated accordingly. Additionally, the safety instruction parameter’s description has been clarified to specify compatibility only with models from the Command R 08-2024 release, and the parameter is now marked as deprecated.

Changes

File Change Summary
src/libs/Cohere/openapi.yaml Updated model ID from command-r-plus-08-2024 to command-a-03-2025 across examples (Python, Java, TypeScript, Go, cURL); revised safety instructions; added deprecated: true to a parameter.

Possibly related PRs

Suggested reviewers

  • github-actions

Poem

I'm a rabbit, hopping with glee,
Updating APIs for everyone to see.
New model names in the code trail,
Deprecated warnings now set sail.
Hop along, let the changes prevail!
🐇🎉


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.

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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 April 2, 2025 18:29
@HavenDV HavenDV merged commit 2907656 into main Apr 2, 2025
3 of 4 checks passed
@HavenDV HavenDV deleted the bot/update-openapi_202504021828 branch April 2, 2025 18:31
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Update model id to command-a-03-2025, deprecate safety instr param Apr 2, 2025
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 (4)
src/libs/Cohere/openapi.yaml (4)

155-161: Review Safety Instruction Description References
The safety instruction parameter’s description now provides comprehensive details (including fallback and default modes). However, it still refers to “Command R 08-2024” and “Command R+ 08-2024”. If the intention is to migrate entirely to the new model (i.e. command-a-03-2025), please double-check whether these version references should be updated or explicitly noted as legacy.


851-857: Deprecation of Custom Playground Preset Parameter
The custom playground preset parameter is now marked as deprecated and its description clarifies its usage. Please verify that the double apostrophe in preset''s parameters is intentional for proper YAML escaping. If not, consider switching to a block-style literal for enhanced readability.


7433-7439: Safety Instruction Parameter Details and Deprecation Consideration
The safety instruction parameter’s description now details the available modes and their behaviors. In light of the PR summary noting that this parameter is deprecated, please ensure that a deprecated: true flag is added if that is the intended change.


7831-7849: Tools Integration Code Samples Updated
The tools integration examples (for TypeScript, Python, Java, Go, and cURL) have been revised to use the new model identifier. Ensure that function definitions and parameter schema details (for functions like query_daily_sales_report and query_product_catalog) remain aligned with the overall API design and the new model’s specifications.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3cfd6b8 and c9fe879.

⛔ Files ignored due to path filters (11)
  • src/libs/Cohere/Generated/Cohere.CohereClient.Chat.g.cs is excluded by !**/generated/**
  • src/libs/Cohere/Generated/Cohere.CohereClient.Chatv2.g.cs is excluded by !**/generated/**
  • src/libs/Cohere/Generated/Cohere.ICohereClient.Chat.g.cs is excluded by !**/generated/**
  • src/libs/Cohere/Generated/Cohere.ICohereClient.Chatv2.g.cs is excluded by !**/generated/**
  • src/libs/Cohere/Generated/Cohere.IModelsClient.GetModel.g.cs is excluded by !**/generated/**
  • src/libs/Cohere/Generated/Cohere.Models.ChatRequest.g.cs is excluded by !**/generated/**
  • src/libs/Cohere/Generated/Cohere.Models.ChatRequestSafetyMode.g.cs is excluded by !**/generated/**
  • src/libs/Cohere/Generated/Cohere.Models.Chatv2Request.g.cs is excluded by !**/generated/**
  • src/libs/Cohere/Generated/Cohere.Models.Chatv2RequestSafetyMode.g.cs is excluded by !**/generated/**
  • src/libs/Cohere/Generated/Cohere.Models.ClassifyRequest.g.cs is excluded by !**/generated/**
  • src/libs/Cohere/Generated/Cohere.ModelsClient.GetModel.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/Cohere/openapi.yaml (13 hunks)
🔇 Additional comments (9)
src/libs/Cohere/openapi.yaml (9)

116-122: Clarify Model Parameter Description
The updated description for the model field now explicitly explains the expected value and directs users to the Cohere models documentation. Please verify that the URL and phrasing remain consistent with current guidelines.


419-424: Consistent Update of Detokenize Code Samples
The code samples for the detokenize functionality (including both synchronous and asynchronous Python examples) have been updated to use model="command-a-03-2025". These changes are consistent and accurately reflect the new model identifier.


2107-2122: Detokenize Examples Updated for New Model
All detokenize code samples across various SDKs (TypeScript, Python sync/async, Java, and cURL) are now using command-a-03-2025. The updates are applied correctly and uniformly.


6790-6796: Schema Example Alignment
The schema example now reflects the updated model identifier (example: command-a-03-2025), which is consistent with the rest of the specification changes.


7313-7331: Tokenization Code Samples Consistency
Tokenization examples in TypeScript, Python, Java, Node.js, and cURL have been updated to use command-a-03-2025. The changes are consistent, and no issues were observed.


7406-7412: Updated Chat Model Parameter Description
The description now points to the Cohere v2 docs for compatibility information. This refresh ensures users can locate up‐to‐date documentation. Please verify that this change is consistently reflected across all similar parameters.


7520-7548: v2-Beta Chat Examples Updated
The v2-beta examples across various SDKs (including TypeScript, Python, Go, Java, cURL) now use model: "command-a-03-2025". The examples are consistent and clearly structured. Please validate these against the latest API specifications.


7561-7579: Chat with Documents Examples Refined
The code samples illustrating chat requests that include documents are updated to use the new model identifier. The integration and sample payloads look correct and consistent.


7703-7721: Streaming Chat Examples Are Consistent
All streaming chat code examples across TypeScript, Python, Java, Go, and cURL have been updated to reflect command-a-03-2025. The stream handling and client usage appear to follow best practices.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant