Skip to content

feat:Update ElevenLabs API specification with audio format and documentation changes#37

Merged
github-actions[bot] merged 1 commit intomainfrom
bot/update-openapi_202501241823
Jan 24, 2025
Merged

feat:Update ElevenLabs API specification with audio format and documentation changes#37
github-actions[bot] merged 1 commit intomainfrom
bot/update-openapi_202501241823

Conversation

@HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Jan 24, 2025

Summary by CodeRabbit

  • New Features

    • Added pcm_8000 audio format option for text-to-voice and speech recognition
    • Set default transcript format to SRT in conversation transcription endpoint
  • Improvements

    • Updated API documentation with clearer schema definitions
    • Removed deprecated flags from text-to-speech schemas

@coderabbitai
Copy link

coderabbitai bot commented Jan 24, 2025

Walkthrough

The pull request introduces modifications to the ElevenLabs API OpenAPI specification, focusing on expanding audio format options and refining API documentation. The changes include adding the pcm_8000 format to input and output schemas, setting a default subtitle format, and removing deprecated flags from certain text-to-speech schemas. These updates aim to enhance the API's flexibility and clarity for developers integrating voice-related functionalities.

Changes

File Change Summary
src/libs/ElevenLabs/openapi.yaml - Added pcm_8000 to ASRInputFormat and TTSOutputFormat schemas
- Set default format_type to srt in /v1/text-to-voice/create-previews endpoint
- Removed deprecated flags from text-to-speech schemas

Poem

🐰 In the realm of voices, a rabbit's delight,
New formats emerge, shining ever so bright
PCM whispers, SRT takes the stage
Deprecated flags fade from the API's page
Innovation hops, with clarity in sight! 🎙️


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cda0180 and 19dcefd.

⛔ Files ignored due to path filters (18)
  • src/libs/ElevenLabs/Generated/ElevenLabs.DubbingClient.GetDubbingByDubbingIdTranscriptByLanguageCode.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.IDubbingClient.GetDubbingByDubbingIdTranscriptByLanguageCode.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.ITextToSpeechClient.CreateTextToSpeechByVoiceId.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.ITextToSpeechClient.CreateTextToSpeechByVoiceIdStream.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.ITextToSpeechClient.CreateTextToSpeechByVoiceIdStreamWithTimestamps.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.ITextToSpeechClient.CreateTextToSpeechByVoiceIdWithTimestamps.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.ASRInputFormat.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechStreamingV1TextToSpeechVoiceIdStreamPost.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechStreamingWithTimestampsV1TextToSpeechVoiceIdStreamWithTimestampsPost.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechV1TextToSpeechVoiceIdPost.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechWithTimestampsV1TextToSpeechVoiceIdWithTimestampsPost.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.GenerateAVoicePreviewFromDescriptionV1TextToVoiceCreatePreviewsPostOutputFormat.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.GetTranscriptForDubV1DubbingDubbingIdTranscriptLanguageCodeGetFormatType.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.TTSOutputFormat.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.TextToSpeechClient.CreateTextToSpeechByVoiceId.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.TextToSpeechClient.CreateTextToSpeechByVoiceIdStream.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.TextToSpeechClient.CreateTextToSpeechByVoiceIdStreamWithTimestamps.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.TextToSpeechClient.CreateTextToSpeechByVoiceIdWithTimestamps.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/ElevenLabs/openapi.yaml (8 hunks)
🔇 Additional comments (7)
src/libs/ElevenLabs/openapi.yaml (7)

832-832: LGTM: SDK group name addition

The addition of SDK group name for voice generation parameters endpoint is appropriate.


Line range hint 887-891: LGTM: Added PCM 8kHz support

The addition of pcm_8000 format expands the audio format options available for voice previews.


1110-1110: LGTM: SDK group name addition

The addition of SDK group name for default voice settings endpoint is appropriate.


1643-1644: LGTM: SDK metadata additions

The addition of SDK method and group names for project content update endpoint is appropriate.


2377-2377: LGTM: Default subtitle format

Setting 'srt' as the default subtitle format is a sensible choice as it's widely supported.


4107-4107: LGTM: Added PCM 8kHz support for ASR

The addition of pcm_8000 format expands the audio format options available for automatic speech recognition input.


8289-8289: LGTM: Added PCM 8kHz support for TTS

The addition of pcm_8000 format expands the audio format options available for text-to-speech output.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 merged commit 771e2a6 into main Jan 24, 2025
2 checks passed
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Update ElevenLabs API specification with audio format and documentation changes Jan 24, 2025
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