-
-
Notifications
You must be signed in to change notification settings - Fork 0
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
feat:Update openapi.yaml file in src/libs/Cohere directory #118
Conversation
WalkthroughThe pull request involves changes to the Changes
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
There was a problem hiding this 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
🧹 Outside diff range and nitpick comments (1)
src/libs/Cohere/openapi.yaml (1)
762-766
: LGTM! Consider adding example response format.The addition of the
stream
property is well-documented with clear descriptions of behavior, use cases, and platform compatibility. The OpenAPI specification is correctly formatted.Consider enhancing the documentation by adding an example of the SSE event format in the description. This would help developers better understand the response structure. For example:
stream: type: boolean - description: "Defaults to `false`.\n\nWhen `true`, the response will be a SSE stream of events. The final event will contain the complete response, and will have an `event_type` of `\"stream-end\"`.\n\nStreaming is beneficial for user interfaces that render the contents of the response piece by piece, as it gets generated.\n\nCompatible Deployments: Cohere Platform, Azure, AWS Sagemaker/Bedrock, Private Deployments\n" + description: "Defaults to `false`.\n\nWhen `true`, the response will be a SSE stream of events. The final event will contain the complete response, and will have an `event_type` of `\"stream-end\"`.\n\nStreaming is beneficial for user interfaces that render the contents of the response piece by piece, as it gets generated.\n\nExample SSE event:\ndata: {\"text\": \"partial response\", \"event_type\": \"text-generation\"}\n\ndata: {\"text\": \"final response\", \"event_type\": \"stream-end\"}\n\nCompatible Deployments: Cohere Platform, Azure, AWS Sagemaker/Bedrock, Private Deployments\n"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (3)
src/libs/Cohere/Generated/Cohere.CohereApi.Chatv2.g.cs
is excluded by!**/generated/**
src/libs/Cohere/Generated/Cohere.ICohereApi.Chatv2.g.cs
is excluded by!**/generated/**
src/libs/Cohere/Generated/Cohere.Models.Chatv2Request.g.cs
is excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/Cohere/openapi.yaml
(1 hunks)
🔥 Files not summarized due to errors (1)
- src/libs/Cohere/openapi.yaml: Error: Server error: no LLM provider could handle the message
Summary by CodeRabbit