Conversation
WalkthroughThe changes modify the API specification in the Changes
Possibly related PRs
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
coderabbitai
Bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/libs/ElevenLabs/openapi.yaml (2)
273-283: Audio Formats Enumeration Updates (Part 1)
New audio format values (opus_48000_32,opus_48000_64,opus_48000_96,opus_48000_128,opus_48000_192) have been added to several endpoints. The updates look consistent in the enumeration lists across multiple sections.Also applies to: 536-546, 627-637, 717-727, 809-819, 900-910, 991-1001
17502-17633: WidgetConfig – Expanded UI Configuration
A comprehensive list of widget configuration properties (avatars, colors, fonts, text labels, borders, and more) has been added. All fields include titles, types, descriptions, defaults, and nullability where applicable. Overall, this is a well‐documented enhancement for widget customization.
(Consider verifying that the default color values match your branding guidelines.)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (114)
src/libs/ElevenLabs/Generated/ElevenLabs.ConversationalAIClient.DeleteConvaiAgentsByAgentId.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.ConversationalAIClient.GetConvaiAgents.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.DubbingClient.CreateDubbing.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.IConversationalAIClient.DeleteConvaiAgentsByAgentId.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.IConversationalAIClient.GetConvaiAgents.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.IDubbingClient.CreateDubbing.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.ITextToSpeechClient.CreateTextToSpeechByVoiceId.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.ITextToSpeechClient.CreateTextToSpeechByVoiceIdStream.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.ITextToSpeechClient.CreateTextToSpeechByVoiceIdStreamWithTimestamps.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.ITextToSpeechClient.CreateTextToSpeechByVoiceIdWithTimestamps.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.IVoicesClient.GetSharedVoices.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ASRConversationalConfig.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.AgentCallLimits.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.AgentConfigAPIModelInput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.AgentConfigAPIModelOutput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.AgentConfigOverride.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.AgentConfigOverrideConfig.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.AgentMetadataResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.AgentPlatformSettingsRequestModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.AgentPlatformSettingsRequestModelDataCollection.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.AgentPlatformSettingsResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.AgentPlatformSettingsResponseModelDataCollection.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.AgentSummaryResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.AllowlistItem.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.AuthSettings.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyDubAVideoOrAnAudioFileV1DubbingPost.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechStreamingV1TextToSpeechVoiceIdStreamPost.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechStreamingWithTimestampsV1TextToSpeechVoiceIdStreamWithTimestampsPost.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechV1TextToSpeechVoiceIdPost.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyTextToSpeechWithTimestampsV1TextToSpeechVoiceIdWithTimestampsPost.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ClientToolConfigInput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ClientToolConfigInputType.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ClientToolConfigOutput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ClientToolConfigOutputType.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ConversationConfig.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ConversationInitiationClientDataConfigInput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ConversationInitiationClientDataConfigOutput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ConversationInitiationClientDataWebhook.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ConversationInitiationClientDataWebhookRequestHeaders.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ConversationTokenDBModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ConversationalConfigAPIModelInput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ConversationalConfigAPIModelInputLanguagePresets.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ConversationalConfigAPIModelOutput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ConversationalConfigAPIModelOutputLanguagePresets.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.CreateAgentResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.CreatePhoneNumberResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.CustomLLM.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.DeleteAgentV1ConvaiAgentsAgentIdDeleteResponse.Json.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.DeleteAgentV1ConvaiAgentsAgentIdDeleteResponse.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.DynamicVariablesConfig.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.DynamicVariablesConfigDynamicVariablePlaceholders.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.EmbeddingModelEnum.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.EvaluationSettings.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.GenerateAVoicePreviewFromDescriptionV1TextToVoiceCreatePreviewsPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.GetAgentLinkResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.GetAgentResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.GetAgentsPageResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.GetPhoneNumberResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ImageAvatar.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ImageAvatarType.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.KnowledgeBaseLocator.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.KnowledgeBaseLocatorType.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.LibraryVoiceResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.LiteralJsonSchemaProperty.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.OrbAvatar.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.OrbAvatarType.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.PhoneNumberAgentInfo.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.PrivacyConfig.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.PromptAgentInput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.PromptAgentOutput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.PromptAgentOverride.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.PromptAgentOverrideConfig.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.PromptEvaluationCriteria.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.PromptEvaluationCriteriaType.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.PydanticPronunciationDictionaryVersionLocator.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ResourceAccessInfo.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ResourceAccessInfoRole.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.SoundGenerationV1SoundGenerationPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.SpeechToSpeechStreamingV1SpeechToSpeechVoiceIdStreamPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.SpeechToSpeechV1SpeechToSpeechVoiceIdPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.SystemToolConfig.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.SystemToolConfigType.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.TTSConversationalConfig.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.TTSConversationalConfigOverrideConfig.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.TextToSpeechStreamingV1TextToSpeechVoiceIdStreamPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.TextToSpeechStreamingWithTimestampsV1TextToSpeechVoiceIdStreamWithTimestampsPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.TextToSpeechV1TextToSpeechVoiceIdPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.TextToSpeechWithTimestampsV1TextToSpeechVoiceIdWithTimestampsPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ToolsItem2.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ToolsItem3.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.TurnConfig.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.URLAvatar.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.URLAvatarType.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WebhookToolApiSchemaConfigInput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WebhookToolApiSchemaConfigInputMethod.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WebhookToolApiSchemaConfigInputPathParamsSchema.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WebhookToolApiSchemaConfigInputRequestHeaders.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WebhookToolApiSchemaConfigOutput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WebhookToolApiSchemaConfigOutputMethod.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WebhookToolApiSchemaConfigOutputPathParamsSchema.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WebhookToolApiSchemaConfigOutputRequestHeaders.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WebhookToolConfigInput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WebhookToolConfigInputType.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WebhookToolConfigOutput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WebhookToolConfigOutputType.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WidgetConfig.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WidgetConfigResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.TextToSpeechClient.CreateTextToSpeechByVoiceId.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.TextToSpeechClient.CreateTextToSpeechByVoiceIdStream.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.TextToSpeechClient.CreateTextToSpeechByVoiceIdStreamWithTimestamps.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.TextToSpeechClient.CreateTextToSpeechByVoiceIdWithTimestamps.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.VoicesClient.GetSharedVoices.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/JsonSerializerContext.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/JsonSerializerContextTypes.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/ElevenLabs/openapi.yaml(82 hunks)
🔇 Additional comments (74)
src/libs/ElevenLabs/openapi.yaml (74)
1107-1117: Audio Formats Enumeration – Default Value Check
In this hunk the default value has changed tomp3_44100_192instead of the previously usedmp3_44100_128. Please verify that this change is intentional and that downstream clients will handle the new default correctly.
4551-4565: New Locale Query Parameter
A new query parameterlocalehas been introduced (with description, schema, and example). This addition looks clear. Verify that the intended formats (e.g.en-US) are documented elsewhere as needed.
5807-5813: Response Code Modification
The response section now includes status code204with the description "Agent successfully deleted". Ensure that clients do not expect a content body on 204 responses.
6001-6009: List Agents Endpoint Update
The GET operation for listing agents has updated summary, description, and a clear operationId. The documentation is concise and descriptive.
7163-7174: Enhanced ASR Input Format Example
The ASRInputFormat section now includes examples (with keywords, provider, quality, and user_input_audio_format). This additional example improves clarity.
7380-7393: Agent Configuration Enhancements
In the AgentConfigAPIModel, the propertiesagent_concurrency_limitanddaily_limithave been enhanced with descriptive text and examples. This will help consumers understand usage and constraints.
7441-7454: AgentConfigOverride – Descriptive Update
The override schema now includes nullable string descriptions forfirst_messageandlanguage. The added descriptions are clear, though note that later the override flags change type.
7460-7475: AgentConfigOverride – Flag Type Change
In this hunk the propertiesfirst_messageandlanguagehave changed to boolean values, with descriptions indicating they control whether overriding is allowed. Please double‐check that this change (from expected string content to boolean flags) is aligned with your API’s design.
7481-7485: Timestamp Field Clarity
Thecreated_at_unix_secsfield now has a simplified description. This minor improvement positively enhances understanding.
7497-7511: AgentPlatformSettingsRequestModel Enhancements
The request model now includes additional descriptions (e.g. “Data collection settings”) for properties. This helps clarify the purpose of the configuration.
7521-7531: AgentPlatformSettingsResponseModel Consistency
Mirroring the request model changes, the response model now includes clear descriptions. The consistency between these endpoints is good.
7544-7562: Agent Metadata Update
Additional descriptions have been provided for properties such asagent_id,name, andcreated_at_unix_secsin the metadata response model with an example. This update improves clarity.
7580-7584: Allowed Origin Hostname Description
Thehostnamefield now explicitly describes the hostname of the allowed origin. This is a clear and useful addition.
7802-7814: Auth and Allowlist Configuration Updates
Enhancements have been made to theenable_auth,allowlist, andshareable_tokenproperties for client authentication. The descriptions are complete and add context for proper usage.
8970-8977: Voice Cloning Options Update
The fields related to voice cloning (e.g.disable_voice_cloning) were updated with improved descriptions that mention BETA status. This is helpful for users to understand availability.
9587-9596: Text Normalization Parameter Enhancements (Streaming TTS)
Updates to the text normalization parameters include detailed descriptions, defaults, and examples. This additional documentation could help in setting correct latency expectations.
9683-9692: Text Normalization Parameter Updates (TTS v1)
The similar update for the Body_Text_to_speech_v1 endpoint follows the pattern from the streaming variant. It appears consistent.
9779-9788: Text Normalization Parameter Updates (TTS with Timestamps)
The changes for the Body_Text_to_speech_with_timestamps endpoint mirror the previous updates. Consistency is maintained.
9872-9881: Dubbing Transcription Settings
The Body_Transcribes_segments_v1_dubbing_resource endpoint now includes similar descriptive enhancements for text normalization parameters. This makes the API behavior clearer.
10514-10519: Client Tool Type Description Update
A description for the tool type (defaults toclient) has been added. This helps clarify the role of the tool in client interactions.
10530-10541: Client Tool Response Settings
The parametersexpects_responseandresponse_timeout_secsnow include richer descriptions and examples. This should assist developers in correctly configuring client tools.
10557-10564: Additional Client Tool Type Description
A similar update for another instance of tool configuration reiterates the expected type and properties. Consistency across definitions is maintained.
10573-10591: Further Client Tool Configuration Enhancements
This hunk continues detailing tools that send events to the client with updated descriptions. No issues detected.
10685-10703: Conversation Config Client Override Enhancements
The ConversationConfigClientOverride-Input now features a newclient_eventsarray with description and an example. This should help in configuring client event notifications correctly.
10982-10996: Conversation Initiation Client Data – Output Update
The output model now includes flags forcustom_llm_extra_bodyandenable_conversation_initiation_client_data_from_webhookwith defaults and descriptions. This is a useful clarification.
11001-11015: Conversation Initiation Client Data – Request Update
The corresponding request model has been updated similarly to the output. The consistency between request and response is maintained.
11059-11075: Conversation Signed URL Response Enhancements
Additional details in the ConversationSignedUrlResponseModel regarding request headers (with example) have been added. This will aid in configuring secure webhook calls.
11131-11151: Conversation Token Purpose and Details
The ConversationTokenPurpose section now includes expanded information onagent_id, token, and expiration time. The added example improves clarity.
11180-11186: Conversational Config API Model – Language Presets
The output model now includes a property for language presets with a detailed description. This enhancement should make it easier for consumers to understand how to supply or interpret language-related configuration.
11200-11206: Conversational Config API Model – Agent Submodel
The agent submodel reference has been revalidated and the language presets addition is clearly explained. Good clarity here.
11236-11242: Create Phone Number Response Update
The CreatePhoneNumberResponseModel now includes a description for theagent_idfield. Small but useful documentation detail.
11248-11254: Pronunciation Dictionary Response Update
Minor descriptive updates to the CreatePronunciationDictionaryResponseModel improve understanding of the phone entity ID.
11322-11332: Chat Completions Endpoint – LLM Configuration
This hunk provides enhanced descriptions for the URL, model_id, and api_key fields in the Chat Completions configuration. The clarifications are beneficial.
11787-11795: Edit Chapter Response Model Enhancements
Additional details regarding dynamic variable placeholders have been added along with an example. This provides better guidance for API users.
11853-11859: Evaluation Success Result – Criteria Description
The EvaluationSuccessResult now includes a detailed description of individual criteria. This added context should help in understanding how evaluation success is determined.
12160-12168: Get Agent Response Model – Agent Token Details
The GetAgentResponseModel has been updated with enhanced descriptions for the agent id and conversation token. The improvements add clarity to the token’s intended usage.
12177-12187: Get Agent Response Model – Agent Name & Description
Enhanced description foragent_idandnamein the GetAgentResponseModel helps clarify what each field represents.
12193-12200: Get Agents Page Response Model – Phone Numbers Listing
The schema now includes a description for the list of phone numbers associated with the agent along with an example. This is a helpful addition.
12209-12225: Audio Native Project Settings Response Updates
New fields such asnext_cursorandhas_morehave been added with descriptive text and examples. This enhances pagination support documentation.
12601-12609: Projects Response Model – Phone Number ID Example
The GetProjectsResponseModel now includes an example forphone_number_id, which improves practical understanding.
12991-13001: Invoice Response Model – Avatar Type Description
A small update in the InvoiceResponseModel now clarifies the type for avatars, reinforcing the available options.
13064-13083: Knowledge Base Locator Enhancements
Additional descriptions for properties such astype,name, andidare now present. The example provided helps illustrate the intended structure.
13234-13244: LLM Schema Update – Locale Addition
A newlocalefield has been introduced along withvoicelanguage settings. Please confirm that the distinction between “language” and “locale” is well documented and that consumers know when to use each.
13363-13373: Property Descriptions for Dynamic Variables
The schema now includes more detailed descriptions fordescription,dynamic_variable, and other property attributes. This makes the intended usage clearer.
13377-13386: Manual Verification File Response Model Update
Additional example values and a default forconstant_valuehave been added. This improves the overall clarity of the model.
13715-13734: PatchConvAISettingsRequest – Avatar Color and Type Updates
The PatchConvAISettingsRequest now includes fields for avatar type and additional color properties with defaults and examples. The changes are detailed and align with UI configuration needs.
13749-13760: Podcast Bulletin Mode Schema Enhancements
Descriptions foragent_idandagent_namehave been added. The improved documentation should help developers use this model correctly.
13932-13963: Privacy Settings for Conversations
The privacy settings (record_voice, retention_days, delete flags, etc.) now include comprehensive descriptions and defaults. This is an important update for data retention policies.
14576-14593: PromptAgent Output – Enhanced LLM and Temperature Settings
The PromptAgent-Output section now documents fields such asprompt,llm,temperature, andmax_tokenswith clear descriptions and default values. This will improve LLM configuration clarity.
14598-14609: PromptAgent Tools – Discriminator Addition
The tools list now includes a discriminator mapping to clearly distinguish between client, system, and webhook tools. This enhancement reduces ambiguity in tool configuration.
14665-14706: PromptAgent Override – Configuration Enhancements
Updates to the PromptAgentOverride and its configuration provide additional clarity for prompt management. The new example is also useful.
14733-14739: Prompt Evaluation Criteria – Identification Fields
The addition of anidand refined description for thenamefield improves the definition of evaluation criteria.
14742-14762: Prompt Evaluation Criteria – Detailed Description
The updated prompt evaluation parameters now feature aconversation_goal_promptand a flag foruse_knowledge_basewith an example. This enriches the evaluation process documentation.
14763-14888: Pronunciation Dictionary Alias Rule Request Model Update
Additional descriptive text forpronunciation_dictionary_idandversion_idclarifies how to reference specific dictionary versions. The extended description is very helpful.
15091-15116: Query Parameters JSON Schema – Creator and Role Details
The QueryParamsJsonSchema now explicitly documents fields such asis_creator,creator_name,creator_email, androlealong with examples. This level of detail improves API usability.
16080-16087: System Tool Type Specification
The schema now refines the allowedenumvalue (system) and provides a brief description. This ensures that system tools are clearly distinguished.
16092-16097: TTS Conversational Config – System Tool Clarification
The TTSConversationalConfig now includes a brief description noting it is used for calling system methods. The update is concise and useful.
16104-16110: TTS Conversational Config – Voice ID and Format Update
The inclusion of avoice_idand the reference toTTSOutputFormatin the agent_output_audio_format field provides better control over TTS settings.
16115-16149: TTS Conversational Config – Stability, Speed, and Similarity Settings
The enhancements for stability, speed, similarity_boost, and pronunciation_dictionary_locators are well documented with defaults and an example. This detailed configuration offers fine-tuning for TTS output.
16161-16168: TTS Conversational Config Override – Voice ID Flag
A new boolean flag to allow overriding thevoice_idhas been added. The update is straightforward and useful.
16205-16215: TurnMode Configuration Update
The TurnMode schema now includes aturn_timeoutproperty (with default and example) and a reference toTurnMode. This addition improves real‐time conversation management.
16245-16255: Update Phone Number Request – Custom URL for Webhook
The UpdatePhoneNumberRequest now includes acustom_urlfield with a descriptive note. This change provides better control over webhook endpoints.
17329-17334: Webhook Configuration – URL Description Update
The webhook configuration now includes an updated description for theurlfield that clarifies that path parameters can be included. This is a clear enhancement.
17338-17347: Webhook Configuration – HTTP Method Options
The update provides an enumeration of HTTP methods (PATCH, DELETE) for the webhook along with descriptions. This aids in understanding the allowed methods.
17357-17375: Webhook Request Headers and Schema Enhancements
The webhook configuration now specifies that header values can be either a string or a special secret locator. The detailed example is an excellent touch.
17382-17388: WebhookToolApiSchemaConfig – Output Improvements
Minor improvements to the WebhookToolApiSchemaConfig-Output including title and required fields have been applied. The changes look sound.
17391-17404: WebhookToolApiSchemaConfig – Extended Schema Details
The extended details for path and query parameters increase clarity, especially the mapping for placeholders in URLs. This update is well executed.
17410-17429: WebhookToolConfig-Input – Example and Requirements
The input configuration for webhook tools now shows a concrete example with proper header and request body schema details. This practical example is very useful.
17439-17446: WebhookToolConfig-Input – Tool Type Specification
The tool type is clearly set towebhookwith an updated description. This removes any ambiguity.
17455-17465: WebhookToolConfig-Output – Consolidated Schema
The output configuration for webhook tools is extended with dynamic_variables and clear requirements. The description now succinctly explains its purpose.
17470-17477: WebhookToolConfig-Output – Type Enforcement
This hunk reaffirms that the tool type iswebhookand includes an updated default and description. The changes are straightforward.
17486-17491: WidgetConfig Introduction
The transition from webhook tool definitions to WidgetConfig is introduced here. No issues noted; the separation of concerns is clear.
17645-17700: WidgetConfigResponseModel – Detailed Response Schema
The WidgetConfigResponseModel now mirrors many of the configuration fields in WidgetConfig with similarly detailed descriptions and defaults. The consistency and completeness of this section are commendable.
17768-17796: WidgetExpandable Schema Update
The WidgetExpandable section has been updated with a clear enumeration and an example. This will help in managing widget behavior under various expansion modes.
1 participant
Summary by CodeRabbit
New Features
Documentation