Skip to content

feat:Update ElevenLabs OpenAPI specification with enhanced documentation and parameters#31

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

feat:Update ElevenLabs OpenAPI specification with enhanced documentation and parameters#31
github-actions[bot] merged 1 commit intomainfrom
bot/update-openapi_202501021234

Conversation

@HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Jan 2, 2025

Summary by CodeRabbit

  • Documentation

    • Updated ElevenLabs API specification with clearer descriptions
    • Added new parameter for pronunciation dictionary rules
    • Expanded usage metrics breakdown options
  • Improvements

    • Enhanced API functionality with more precise parameter definitions

@coderabbitai
Copy link

coderabbitai bot commented Jan 2, 2025

Walkthrough

The pull request introduces modifications to the ElevenLabs API's OpenAPI specification. The changes focus on enhancing the API's documentation and functionality by updating schema descriptions, adding new parameters, and expanding enumeration options. These updates provide more precise information about endpoint behaviors and introduce additional flexibility in usage metrics and pronunciation dictionary configurations.

Changes

File Change Summary
src/libs/ElevenLabs/openapi.yaml - Updated Body_Delete_existing_invitation_v1_workspace_invites_delete schema description
- Added use_knowledge_base property to Body_Add_rules_to_the_pronunciation_dictionary schema
- Expanded BreakdownTypes with new groups enumeration value

Poem

🐰 In the realm of APIs, where bits dance and play,
Eleven Labs' spec gets brighter today!
New parameters hop, descriptions gleam,
A rabbit's delight in this coding dream 🌟
Clarity springs forth with each gentle change!


📜 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 fef7c38 and 5e39330.

⛔ Files ignored due to path filters (8)
  • src/libs/ElevenLabs/Generated/ElevenLabs.IWorkspaceClient.CreateWorkspaceInvitesAdd.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.IWorkspaceClient.DeleteWorkspaceInvites.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyDeleteExistingInvitationV1WorkspaceInvitesDelete.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyInviteUserV1WorkspaceInvitesAddPost.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.BreakdownTypes.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.Models.PromptEvaluationCriteria.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.WorkspaceClient.CreateWorkspaceInvitesAdd.g.cs is excluded by !**/generated/**
  • src/libs/ElevenLabs/Generated/ElevenLabs.WorkspaceClient.DeleteWorkspaceInvites.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/ElevenLabs/openapi.yaml (5 hunks)
🔇 Additional comments (2)
src/libs/ElevenLabs/openapi.yaml (2)

683-683: LGTM! Good addition of streaming flag.

The x-fern-streaming: true vendor extension correctly indicates that this endpoint supports streaming responses, which is important for SDK generation.


7619-7622: LGTM! Well-structured schema property addition.

The use_knowledge_base boolean property is a good addition to the PromptEvaluationCriteria schema:

  • Clear default value (false)
  • Logical placement in the schema
  • Follows OpenAPI best practices for boolean flags

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 3c337a5 into main Jan 2, 2025
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Update ElevenLabs OpenAPI specification with enhanced documentation and parameters Jan 2, 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