Skip to content
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:Add new audio processing endpoints for transcriptions and translations #85

Merged
merged 1 commit into from
Nov 15, 2024

Conversation

HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Nov 15, 2024

Summary by CodeRabbit

  • New Features
    • Introduced two new API endpoints for audio processing:
      • /v1/openai/audio/transcriptions for audio transcription.
      • /v1/openai/audio/translations for audio translation.
    • Both endpoints support file uploads and various optional parameters for enhanced functionality.

Copy link

coderabbitai bot commented Nov 15, 2024

Walkthrough

The changes introduce two new endpoints to the OpenAPI specification for audio processing: /v1/openai/audio/transcriptions and /v1/openai/audio/translations. Both endpoints support the POST method and require specific headers and multipart/form-data request bodies. The request bodies for each endpoint include file and model parameters, with optional parameters for additional configurations. The response structures are defined for successful and error states, and new schemas for the request bodies have been added to the components section.

Changes

File Change Summary
src/libs/DeepInfra/openapi.yaml Added endpoints: /v1/openai/audio/transcriptions and /v1/openai/audio/translations with POST method. Updated request body schemas for both endpoints.

Poem

In a world of sound, we now can play,
Transcribe and translate, hip-hip-hooray!
With models and files, our voices will soar,
New endpoints await, let creativity pour!
🐰✨


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
🪧 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.

@github-actions github-actions bot enabled auto-merge November 15, 2024 21:16
@github-actions github-actions bot merged commit 72e64cf into main Nov 15, 2024
3 checks passed
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Add new audio processing endpoints for transcriptions and translations Nov 15, 2024
Copy link

@coderabbitai coderabbitai bot left a 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 (3)
src/libs/DeepInfra/openapi.yaml (3)

1467-1501: Consider enhancing the transcription endpoint specification.

The endpoint definition could be improved with:

  1. Specify the response content type and schema for 200 status
  2. Add rate limiting headers
  3. Document file size limits and supported audio formats
  /v1/openai/audio/transcriptions:
    post:
      summary: Openai Audio Transcriptions
+     description: Transcribe audio files to text with optional language detection and formatting options.
      operationId: openai_audio_transcriptions_v1_openai_audio_transcriptions_post
      parameters:
        - name: x-deepinfra-source
          in: header
          schema:
            title: X-Deepinfra-Source
            type: string
+       - name: x-ratelimit-limit
+         in: header
+         schema:
+           type: integer
+           description: Request limit per hour
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudioTranscriptionResponse'
+       '413':
+         description: Payload Too Large
+         content:
+           application/json:
+             schema:
+               $ref: '#/components/schemas/DeepError'

2693-2765: Enhance request body schemas with better documentation.

The request body schemas could be improved with:

  1. Better documentation for supported file formats and size limits
  2. Clearer descriptions for parameters like temperature and response_format
  3. Examples for each parameter
    Body_openai_audio_transcriptions_v1_openai_audio_transcriptions_post:
      title: Body_openai_audio_transcriptions_v1_openai_audio_transcriptions_post
      required:
        - file
        - model
      type: object
      properties:
        file:
          title: File
          type: string
          format: binary
+         description: |
+           The audio file to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.
+           Maximum file size: 25MB.
        model:
          title: Model
          type: string
+         description: ID of the model to use. Only whisper-1 is currently available.
+         example: whisper-1
        temperature:
          title: Temperature
          type: number
          default: 0
+         description: |
+           The sampling temperature, between 0 and 1.
+           Higher values like 0.8 will make the output more random,
+           while lower values like 0.2 will make it more focused and deterministic.

4645-4646: Consider grouping related schema variant keys.

The schema variant keys could be better organized by grouping related functionality together.

    SchemaVariantKey:
      title: SchemaVariantKey
      enum:
-       - openai-completions
-       - openai-chat-completions
-       - openai-embeddings
-       - openai-speech-to-text
+       # Text generation
+       - openai-completions
+       - openai-chat-completions
+       # Embeddings
+       - openai-embeddings
+       # Audio processing
+       - openai-speech-to-text
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b62129c and c017d1e.

⛔ Files ignored due to path filters (25)
  • src/libs/DeepInfra/Generated/DeepInfra.DeepInfraApi.OpenaiAudioTranscriptions.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.DeepInfraApi.OpenaiAudioTranslations.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.IDeepInfraApi.OpenaiAudioTranscriptions.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.IDeepInfraApi.OpenaiAudioTranslations.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.Models.BodyOpenaiAudioTranscriptionsV1OpenaiAudioTranscriptionsPost.Json.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.Models.BodyOpenaiAudioTranscriptionsV1OpenaiAudioTranscriptionsPost.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.Models.BodyOpenaiAudioTranscriptionsV1OpenaiAudioTranscriptionsPostResponseFormat.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.Models.BodyOpenaiAudioTranscriptionsV1OpenaiAudioTranscriptionsPostTimestampGranularitie.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.Models.BodyOpenaiAudioTranslationsV1OpenaiAudioTranslationsPost.Json.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.Models.BodyOpenaiAudioTranslationsV1OpenaiAudioTranslationsPost.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.Models.BodyOpenaiAudioTranslationsV1OpenaiAudioTranslationsPostResponseFormat.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.Models.ModelDocBlockKey.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.Models.OpenaiAudioTranscriptionsV1OpenaiAudioTranscriptionsPostResponse.Json.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.Models.OpenaiAudioTranscriptionsV1OpenaiAudioTranscriptionsPostResponse.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.Models.OpenaiAudioTranslationsV1OpenaiAudioTranslationsPostResponse.Json.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.Models.OpenaiAudioTranslationsV1OpenaiAudioTranslationsPostResponse.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/DeepInfra.Models.SchemaVariantKey.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/JsonConverters.BodyOpenaiAudioTranscriptionsV1OpenaiAudioTranscriptionsPostResponseFormat.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/JsonConverters.BodyOpenaiAudioTranscriptionsV1OpenaiAudioTranscriptionsPostResponseFormatNullable.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/JsonConverters.BodyOpenaiAudioTranscriptionsV1OpenaiAudioTranscriptionsPostTimestampGranularitie.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/JsonConverters.BodyOpenaiAudioTranscriptionsV1OpenaiAudioTranscriptionsPostTimestampGranularitieNullable.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/JsonConverters.BodyOpenaiAudioTranslationsV1OpenaiAudioTranslationsPostResponseFormat.g.cs is excluded by !**/generated/**
  • src/libs/DeepInfra/Generated/JsonConverters.BodyOpenaiAudioTranslationsV1OpenaiAudioTranslationsPostResponseFormatNullable.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 (4 hunks)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant