feat:Title: Update documentation for API endpoints and usage examples

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced a new reusable schema, AudioResponseFormat, for defining response formats in transcription and translation requests.
  • Updated examples for transcription to align with the new schema structure.

• Bug Fixes

  • Enhanced clarity and consistency in the API specification by abstracting the response_format field.

[coderabbitai]

Walkthrough

The changes involve refactoring the response_format field in the OpenAI API specification by replacing its inline definition with a reference to a new reusable schema called AudioResponseFormat. This schema consolidates the enum values, description, and default value previously defined inline. The updates affect both transcription and translation requests, while the example for the transcription object is also revised to align with the new structure.

Changes

Files	Change Summary
src/libs/OpenAI/openapi.yaml	- Added schema AudioResponseFormat with enum values: json, text, srt, verbose_json, vtt. - Updated response_format in CreateTranscriptionRequest and CreateTranslationRequest to reference the new schema instead of inline definitions.

Poem

In the garden of code, a change took flight,
A schema was born, bringing clarity bright.
With formats now wrapped in a neat little bow,
Our API blossoms, watch it grow!
Hopping with joy, we celebrate this day,
For tidy design leads the coder's way! 🐇✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c05598e and 958ee27.

Files ignored due to path filters (11)

• src/libs/OpenAI/Generated/JsonConverters.AudioResponseFormat.g.cs is excluded by !**/generated/**
• src/libs/OpenAI/Generated/JsonConverters.AudioResponseFormatNullable.g.cs is excluded by !**/generated/**
• src/libs/OpenAI/Generated/JsonSerializerContext.g.cs is excluded by !**/generated/**
• src/libs/OpenAI/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**
• src/libs/OpenAI/Generated/OpenAI.AudioClient.CreateTranscription.g.cs is excluded by !**/generated/**
• src/libs/OpenAI/Generated/OpenAI.AudioClient.CreateTranslation.g.cs is excluded by !**/generated/**
• src/libs/OpenAI/Generated/OpenAI.IAudioClient.CreateTranscription.g.cs is excluded by !**/generated/**
• src/libs/OpenAI/Generated/OpenAI.IAudioClient.CreateTranslation.g.cs is excluded by !**/generated/**
• src/libs/OpenAI/Generated/OpenAI.Models.AudioResponseFormat.g.cs is excluded by !**/generated/**
• src/libs/OpenAI/Generated/OpenAI.Models.CreateTranscriptionRequest.g.cs is excluded by !**/generated/**
• src/libs/OpenAI/Generated/OpenAI.Models.CreateTranslationRequest.g.cs is excluded by !**/generated/**

Files selected for processing (1)

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

---

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.