feat:Add descriptions to /finetuning endpoints and support "thinking" chat type #231
Conversation
WalkthroughThis update enhances the OpenAPI specification by adding detailed descriptions to several Changes
Poem
✨ Finishing Touches🧪 Generate unit tests
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: 1
♻️ Duplicate comments (1)
src/libs/Cohere/openapi.yaml (1)
12597-12601: Enum value without schema definition
This enum now referencesthinking, but until the missing schema above is added clients will fail to generate types. Fixing the previous comment will resolve this too.
🧹 Nitpick comments (6)
src/libs/Cohere/openapi.yaml (6)
5684-5688: Consider mentioning pagination & response token details
The new description is helpful, but users will likely look for details on how to paginate (page_size,next_page_token, max limits ). A single sentence clarifying that the response containsnext_page_token(or whatever the spec actually returns) would remove ambiguity.
5816-5818: Describe async behaviour & expected response code
The endpoint kicks off a long-running training job, so most providers return 202 Accepted with a polling location / event stream. If that is the case here, call it out explicitly in the description (and in theresponsessection).
5905-5907: Use YAML block scalars for multi-line text
The embedded\nescapes are valid, but they hurt readability and make diffs noisy. A folded or literal block is clearer:- description: "Returns a list of events that occurred during the life-cycle of the fine-tuned model.\nThe events are ordered by creation time, with the most recent event first.\nThe list can be paginated using `page_size` and `page_token` parameters." + description: | + Returns a list of events that occurred during the life-cycle of the fine-tuned model. + The events are ordered by creation time, with the most recent event first. + The list can be paginated using `page_size` and `page_token` parameters.Apply the same style to the other multiline descriptions for consistency.
6018-6020: Same block-scalar readability comment as above
The triple-escaped string would be clearer using|or>style.
6129-6131: Minor wording tweak
“will be removed from the system” could be interpreted as immediate physical deletion. If a grace period or soft-delete exists, spell it out to avoid surprises.
6315-6317: Clarify what can be updated
If only thenameand a subset of settings are mutable, enumerate them here to prevent over-expectation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (16)
src/libs/Cohere/Generated/Cohere.FinetuningClient.CreateFinetunedModel.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.FinetuningClient.DeleteFinetunedModel.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.FinetuningClient.GetFinetunedModel.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.FinetuningClient.ListEvents.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.FinetuningClient.ListFinetunedModels.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.FinetuningClient.ListTrainingStepMetrics.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.FinetuningClient.UpdateFinetunedModel.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IFinetuningClient.CreateFinetunedModel.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IFinetuningClient.DeleteFinetunedModel.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IFinetuningClient.GetFinetunedModel.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IFinetuningClient.ListEvents.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IFinetuningClient.ListFinetunedModels.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IFinetuningClient.ListTrainingStepMetrics.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.IFinetuningClient.UpdateFinetunedModel.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.Models.AssistantMessageResponseContentItemDiscriminatorType.g.csis excluded by!**/generated/**src/libs/Cohere/Generated/Cohere.Models.ChatContentStartEventVariant2DeltaMessageContentType.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/Cohere/openapi.yaml(9 hunks)
🔇 Additional comments (1)
src/libs/Cohere/openapi.yaml (1)
6210-6212: LGTM – concise and clear
No issues spotted.
| propertyName: type | ||
| mapping: | ||
| text: '#/components/schemas/ChatTextContent' | ||
| thinking: '#/components/schemas/ChatThinkingContent' |
There was a problem hiding this comment.
ChatThinkingContent schema is missing – spec will break
The discriminator now maps thinking to #/components/schemas/ChatThinkingContent, but that schema isn’t defined anywhere in the file. This makes the OpenAPI document invalid.
+ ChatThinkingContent:
+ type: object
+ description: Content representing the assistant’s chain-of-thought. **Not returned to the end user** unless explicitly requested.
+ properties:
+ type:
+ type: string
+ enum: [thinking]
+ text:
+ type: string
+ required: [type, text]Add a proper schema (and possibly mark it readOnly: true or behind a feature flag) before merging.
Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In src/libs/Cohere/openapi.yaml around lines 12364 to 12367, the discriminator
mapping references a ChatThinkingContent schema that is not defined, causing the
OpenAPI spec to be invalid. Define the ChatThinkingContent schema in the
components/schemas section with appropriate properties, and consider marking it
as readOnly or gating it behind a feature flag as suggested. This will ensure
the spec is valid and the discriminator mapping works correctly.
Summary by CodeRabbit
New Features
Documentation