feat:Add ChatCompletionContentPartAudio and InputAudio schemas to OpenAPI

[HavenDV]

Summary by CodeRabbit

• New Features
  • Added audio input support to chat completions, allowing users to include audio data along with textual messages.
  • Audio data can be provided in WAV or MP3 formats, with WAV set as the default when not specified.

[coderabbitai]

Walkthrough

This pull request introduces two new schemas to the OpenAPI specification to extend chat completion capabilities. The new ChatCompletionContentPartAudio schema requires a type property with the fixed value input_audio and an input_audio property referencing the InputAudio schema. The InputAudio schema defines a required data property and an optional format property with allowed values wav and mp3, defaulting to wav. Additionally, the audio content schema is included in the anyOf clause of the existing ChatCompletionUserMessage schema.

Changes

File	Change Summary
src/libs/DeepInfra/openapi.yaml	Added ChatCompletionContentPartAudio and InputAudio schemas. Integrated the new audio schema into the ChatCompletionUserMessage's anyOf clause.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Validator

    Client->>API: Send chat completion request with audio data
    API->>Validator: Validate against ChatCompletionUserMessage schema
    Validator-->>API: Confirm audio input (ChatCompletionContentPartAudio with InputAudio)
    API-->>Client: Respond acknowledging audio input acceptance

Loading

Suggested reviewers

• github-actions

Poem

I'm a rabbit, hopping through code with delight,
Schemas sprout like carrots in morning light.
Audio inputs now join the chatter,
Bringing sound where words once clattered.
I twitch my ears with joy so true—
Celebrating changes made fresh and new!

---

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

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

3457-3470: New Schema: ChatCompletionContentPartAudio
The new schema ChatCompletionContentPartAudio correctly defines an object with the required properties type and input_audio. The type field is constrained to the fixed value input_audio, and the input_audio property properly references the InputAudio schema. This implementation meets the PR’s objective of extending chat completion capabilities to handle audio inputs.

Consider adding a brief description for the type field to further clarify that it is meant to always use the fixed value "input_audio".

---

4185-4200: New Schema: InputAudio
The InputAudio schema is implemented appropriately: it requires a data property (of type string) and offers an optional format property constrained to either wav or mp3 (defaulting to wav). This schema provides a solid foundation for handling audio input data.

Consider enhancing the documentation for the data property—for example, clarifying whether it should be base64-encoded audio or raw data—to improve clarity for API consumers.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 61fc581 and a84f735.

⛔ Files ignored due to path filters (16)

• src/libs/DeepInfra/Generated/AnyOf.3.Json.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/AnyOf.3.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.ChatCompletionContentPartAudio.Json.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.ChatCompletionContentPartAudio.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.ChatCompletionContentPartAudioType.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.ChatCompletionUserMessage.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.InputAudio.Json.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.InputAudio.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/DeepInfra.Models.InputAudioFormat.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/JsonConverters.AnyOf3.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/JsonConverters.ChatCompletionContentPartAudioType.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/JsonConverters.ChatCompletionContentPartAudioTypeNullable.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/JsonConverters.InputAudioFormat.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/JsonConverters.InputAudioFormatNullable.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/JsonSerializerContext.g.cs is excluded by !**/generated/**
• src/libs/DeepInfra/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🔇 Additional comments (1)

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

3583-3585: Integration Update: Inclusion in ChatCompletionUserMessage
The reference to ChatCompletionContentPartAudio is now included in the anyOf array of the content property within the ChatCompletionUserMessage schema. This integration allows API consumers to specify audio-based message content alongside text and image content.