feat:Update classification OpenAPI docs with fine-tuned model placeholder

[HavenDV]

Summary by CodeRabbit

• Documentation
  • Updated API documentation with clearer examples including a placeholder for specifying your fine-tuned model ID.
  • Refined the description of the model identifier for a more concise and user-friendly explanation.

[coderabbitai]

Walkthrough

This pull request updates the API documentation in src/libs/Cohere/openapi.yaml by refining the descriptions and examples for the classification model. The changes simplify the model identifier description and introduce the <YOUR-FINE-TUNED-MODEL-ID> placeholder in code examples across multiple SDKs. The request structure for classification is adjusted accordingly, ensuring consistent usage of the new model parameter.

Changes

File	Change Summary
src/libs/Cohere/openapi.yaml	Updated model identifier description; inserted <YOUR-FINE-TUNED-MODEL-ID> placeholder in examples for Go, TypeScript, Python, Java, and cURL; adjusted request structure for classification endpoints.

Suggested reviewers

• github-actions

Poem

I hop through the docs with a joyful leap,
Fine-tuned IDs now ready to keep.
Each line and code blends in delight,
In every SDK, it’s shining bright.
A bunny’s cheer in ASCII and rhyme,
Celebrating clarity one line at a time!
🐇🌟

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

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.

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 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 (1)

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

1037-1043: Align Placeholder Formatting for Consistency

In this request body example, the model field is set as model: YOUR-FINE-TUNED-MODEL-ID (without angle brackets), which deviates from the <YOUR-FINE-TUNED-MODEL-ID> format used in the code samples above. For consistency and clarity, consider updating it to include the angle brackets or confirming that this variation is intentional.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ef7cc96 and 10b98bc.

⛔ Files ignored due to path filters (3)

• src/libs/Cohere/Generated/Cohere.CohereClient.Classify.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.ICohereClient.Classify.g.cs is excluded by !**/generated/**
• src/libs/Cohere/Generated/Cohere.Models.ClassifyRequest.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🔇 Additional comments (2)

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

842-848: Clarify Model Description

The updated model property now includes a concise description for the fine-tuned Classify model along with a helpful documentation link. It would be beneficial to ensure that accompanying documentation clearly instructs users to replace this placeholder with their actual model ID.

---

1012-1033: Ensure Consistency in SDK Code Samples

The code examples across various SDKs consistently use the <YOUR-FINE-TUNED-MODEL-ID> placeholder. This uniform usage guarantees a coherent developer experience irrespective of the programming language. Additionally, consider highlighting in the documentation that this placeholder must be replaced with an actual, valid model ID during integration.