feat:Update OpenAPI specification for Mistral AI API with new schemas and modifications

[HavenDV]

Summary by CodeRabbit

• New Features
  • Introduced a new schema, ReferenceChunk, for improved API response handling.
  • Enhanced flexibility in message handling with updates to AssistantMessage, ToolMessage, and UserMessage schemas.
  • Updated ChatCompletionChoice schema to reference the new AssistantMessage.
  • Defined ContentChunk as a union type to support multiple content formats (text and images).
• Improvements
  • Updated messages property in ChatCompletionRequest schema to accommodate new message structures.

[coderabbitai]

Walkthrough

The pull request introduces modifications to the OpenAPI specification for the Mistral AI API. Key changes include the addition of a new schema, ReferenceChunk, and updates to existing schemas such as AssistantMessage, ToolMessage, and UserMessage to allow null values in their content properties. The ChatCompletionChoice schema now references AssistantMessage instead of DeltaMessage, and the ContentChunk schema is defined as a union type to accommodate multiple content types. These changes enhance the API's flexibility and response structure.

Changes

File	Change Summary
src/libs/Mistral/openapi.yaml	- Added new schema: ReferenceChunk - Updated schemas: AssistantMessage, ToolMessage, UserMessage to allow null in content - Updated ChatCompletionChoice to reference AssistantMessage instead of DeltaMessage - Defined ContentChunk as a union type with TextChunk and ImageURLChunk - Updated messages property in ChatCompletionRequest to accommodate new structures

Poem

In the meadow where ideas bloom,
New schemas dance, dispelling gloom.
ReferenceChunk hops with delight,
Messages flexible, shining bright.
With each update, our API sings,
A world of content, oh what joy it brings! 🐇✨

---

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?

❤️ 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 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

🧹 Outside diff range and nitpick comments (1)

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

2885-2903: LGTM! Well-structured schema for reference handling

The new ReferenceChunk schema is well-designed for content referencing. It provides a clean way to link to external content through IDs while maintaining type safety.

Consider documenting the reference resolution process and any constraints on reference_ids in the schema description to help API consumers.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 059ef03 and 14761ca.

⛔ Files ignored due to path filters (11)

• src/libs/Mistral/Generated/JsonConverters.ReferenceChunkType.g.cs is excluded by !**/generated/**
• src/libs/Mistral/Generated/JsonConverters.ReferenceChunkTypeNullable.g.cs is excluded by !**/generated/**
• src/libs/Mistral/Generated/JsonSerializerContext.g.cs is excluded by !**/generated/**
• src/libs/Mistral/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**
• src/libs/Mistral/Generated/Mistral.Models.AssistantMessage.g.cs is excluded by !**/generated/**
• src/libs/Mistral/Generated/Mistral.Models.ChatCompletionChoice.g.cs is excluded by !**/generated/**
• src/libs/Mistral/Generated/Mistral.Models.ReferenceChunk.Json.g.cs is excluded by !**/generated/**
• src/libs/Mistral/Generated/Mistral.Models.ReferenceChunk.g.cs is excluded by !**/generated/**
• src/libs/Mistral/Generated/Mistral.Models.ReferenceChunkType.g.cs is excluded by !**/generated/**
• src/libs/Mistral/Generated/Mistral.Models.ToolMessage.g.cs is excluded by !**/generated/**
• src/libs/Mistral/Generated/Mistral.Models.UserMessage.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/Mistral/openapi.yaml (5 hunks)

🔇 Additional comments (2)

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

Line range hint 2510-2518: LGTM! Enhanced content flexibility

The content property changes in AssistantMessage improve message handling by supporting:

• Null values for optional content
• Arrays of ContentChunk for rich content
• Consistent typing with other message schemas

---

3013-3018: LGTM! Consistent message schema patterns

The content property changes in ToolMessage and UserMessage maintain consistency with AssistantMessage, creating a uniform approach to content handling across all message types.

Also applies to: 3051-3054